<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>IgH EtherCAT Master: coe_emerg_ring.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">IgH EtherCAT Master
   &#160;<span id="projectnumber">1.5.2</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('coe__emerg__ring_8h.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">coe_emerg_ring.h File Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>EtherCAT CoE emergency ring buffer structure.  
<a href="#details">More...</a></p>

<p><a href="coe__emerg__ring_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structec__coe__emerg__msg__t.html">ec_coe_emerg_msg_t</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">EtherCAT CoE emergency message record.  <a href="structec__coe__emerg__msg__t.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structec__coe__emerg__ring__t.html">ec_coe_emerg_ring_t</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">EtherCAT CoE emergency ring buffer.  <a href="structec__coe__emerg__ring__t.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a29d0aa3bea8dc5911ec6e90e43220fcf"><td class="memItemLeft" align="right" valign="top"><a id="a29d0aa3bea8dc5911ec6e90e43220fcf"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="coe__emerg__ring_8h.html#a29d0aa3bea8dc5911ec6e90e43220fcf">ec_coe_emerg_ring_init</a> (<a class="el" href="structec__coe__emerg__ring__t.html">ec_coe_emerg_ring_t</a> *, <a class="el" href="group__ApplicationInterface.html#ga81f6717d9d4157df53b863e5ee3b04a4">ec_slave_config_t</a> *)</td></tr>
<tr class="memdesc:a29d0aa3bea8dc5911ec6e90e43220fcf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Emergency ring buffer constructor. <br /></td></tr>
<tr class="separator:a29d0aa3bea8dc5911ec6e90e43220fcf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa2cc2988730a5be5b4501447bee6ccac"><td class="memItemLeft" align="right" valign="top"><a id="aa2cc2988730a5be5b4501447bee6ccac"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="coe__emerg__ring_8h.html#aa2cc2988730a5be5b4501447bee6ccac">ec_coe_emerg_ring_clear</a> (<a class="el" href="structec__coe__emerg__ring__t.html">ec_coe_emerg_ring_t</a> *)</td></tr>
<tr class="memdesc:aa2cc2988730a5be5b4501447bee6ccac"><td class="mdescLeft">&#160;</td><td class="mdescRight">Emergency ring buffer destructor. <br /></td></tr>
<tr class="separator:aa2cc2988730a5be5b4501447bee6ccac"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acb06d77fa2cfacd990ce1be541d01911"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="coe__emerg__ring_8h.html#acb06d77fa2cfacd990ce1be541d01911">ec_coe_emerg_ring_size</a> (<a class="el" href="structec__coe__emerg__ring__t.html">ec_coe_emerg_ring_t</a> *, size_t)</td></tr>
<tr class="memdesc:acb06d77fa2cfacd990ce1be541d01911"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the ring size.  <a href="#acb06d77fa2cfacd990ce1be541d01911">More...</a><br /></td></tr>
<tr class="separator:acb06d77fa2cfacd990ce1be541d01911"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7dc4cc68ee9867298393aef837b95dce"><td class="memItemLeft" align="right" valign="top"><a id="a7dc4cc68ee9867298393aef837b95dce"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="coe__emerg__ring_8h.html#a7dc4cc68ee9867298393aef837b95dce">ec_coe_emerg_ring_push</a> (<a class="el" href="structec__coe__emerg__ring__t.html">ec_coe_emerg_ring_t</a> *, const u8 *)</td></tr>
<tr class="memdesc:a7dc4cc68ee9867298393aef837b95dce"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add a new emergency message. <br /></td></tr>
<tr class="separator:a7dc4cc68ee9867298393aef837b95dce"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad4fb61580d89c5ba36a7506bbe184351"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="coe__emerg__ring_8h.html#ad4fb61580d89c5ba36a7506bbe184351">ec_coe_emerg_ring_pop</a> (<a class="el" href="structec__coe__emerg__ring__t.html">ec_coe_emerg_ring_t</a> *, u8 *)</td></tr>
<tr class="memdesc:ad4fb61580d89c5ba36a7506bbe184351"><td class="mdescLeft">&#160;</td><td class="mdescRight">Remove an emergency message from the ring.  <a href="#ad4fb61580d89c5ba36a7506bbe184351">More...</a><br /></td></tr>
<tr class="separator:ad4fb61580d89c5ba36a7506bbe184351"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a99adb5039654b9cd9e2d5a934b8a74fe"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="coe__emerg__ring_8h.html#a99adb5039654b9cd9e2d5a934b8a74fe">ec_coe_emerg_ring_clear_ring</a> (<a class="el" href="structec__coe__emerg__ring__t.html">ec_coe_emerg_ring_t</a> *)</td></tr>
<tr class="memdesc:a99adb5039654b9cd9e2d5a934b8a74fe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clear the ring.  <a href="#a99adb5039654b9cd9e2d5a934b8a74fe">More...</a><br /></td></tr>
<tr class="separator:a99adb5039654b9cd9e2d5a934b8a74fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a75b251ca1fd01e052960e5a0dfd903f6"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="coe__emerg__ring_8h.html#a75b251ca1fd01e052960e5a0dfd903f6">ec_coe_emerg_ring_overruns</a> (<a class="el" href="structec__coe__emerg__ring__t.html">ec_coe_emerg_ring_t</a> *)</td></tr>
<tr class="memdesc:a75b251ca1fd01e052960e5a0dfd903f6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read the number of overruns.  <a href="#a75b251ca1fd01e052960e5a0dfd903f6">More...</a><br /></td></tr>
<tr class="separator:a75b251ca1fd01e052960e5a0dfd903f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>EtherCAT CoE emergency ring buffer structure. </p>

<p class="definition">Definition in file <a class="el" href="coe__emerg__ring_8h_source.html">coe_emerg_ring.h</a>.</p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="acb06d77fa2cfacd990ce1be541d01911"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acb06d77fa2cfacd990ce1be541d01911">&#9670;&nbsp;</a></span>ec_coe_emerg_ring_size()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int ec_coe_emerg_ring_size </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structec__coe__emerg__ring__t.html">ec_coe_emerg_ring_t</a> *&#160;</td>
          <td class="paramname"><em>ring</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&#160;</td>
          <td class="paramname"><em>size</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Set the ring size. </p>
<dl class="section return"><dt>Returns</dt><dd>Zero on success, otherwise a negative error code. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ring</td><td>Emergency ring. </td></tr>
    <tr><td class="paramname">size</td><td>Maximum number of messages in the ring. </td></tr>
  </table>
  </dd>
</dl>

<p class="definition">Definition at line <a class="el" href="coe__emerg__ring_8c_source.html#l00078">78</a> of file <a class="el" href="coe__emerg__ring_8c_source.html">coe_emerg_ring.c</a>.</p>

</div>
</div>
<a id="ad4fb61580d89c5ba36a7506bbe184351"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad4fb61580d89c5ba36a7506bbe184351">&#9670;&nbsp;</a></span>ec_coe_emerg_ring_pop()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int ec_coe_emerg_ring_pop </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structec__coe__emerg__ring__t.html">ec_coe_emerg_ring_t</a> *&#160;</td>
          <td class="paramname"><em>ring</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u8 *&#160;</td>
          <td class="paramname"><em>msg</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Remove an emergency message from the ring. </p>
<dl class="section return"><dt>Returns</dt><dd>Zero on success, otherwise a negative error code. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ring</td><td>Emergency ring. </td></tr>
    <tr><td class="paramname">msg</td><td>Memory to store the emergency message. </td></tr>
  </table>
  </dd>
</dl>

<p class="definition">Definition at line <a class="el" href="coe__emerg__ring_8c_source.html#l00135">135</a> of file <a class="el" href="coe__emerg__ring_8c_source.html">coe_emerg_ring.c</a>.</p>

</div>
</div>
<a id="a99adb5039654b9cd9e2d5a934b8a74fe"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a99adb5039654b9cd9e2d5a934b8a74fe">&#9670;&nbsp;</a></span>ec_coe_emerg_ring_clear_ring()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int ec_coe_emerg_ring_clear_ring </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structec__coe__emerg__ring__t.html">ec_coe_emerg_ring_t</a> *&#160;</td>
          <td class="paramname"><em>ring</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Clear the ring. </p>
<dl class="section return"><dt>Returns</dt><dd>Zero on success, otherwise a negative error code. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ring</td><td>Emergency ring. </td></tr>
  </table>
  </dd>
</dl>

<p class="definition">Definition at line <a class="el" href="coe__emerg__ring_8c_source.html#l00155">155</a> of file <a class="el" href="coe__emerg__ring_8c_source.html">coe_emerg_ring.c</a>.</p>

</div>
</div>
<a id="a75b251ca1fd01e052960e5a0dfd903f6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a75b251ca1fd01e052960e5a0dfd903f6">&#9670;&nbsp;</a></span>ec_coe_emerg_ring_overruns()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int ec_coe_emerg_ring_overruns </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structec__coe__emerg__ring__t.html">ec_coe_emerg_ring_t</a> *&#160;</td>
          <td class="paramname"><em>ring</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Read the number of overruns. </p>
<dl class="section return"><dt>Returns</dt><dd>Number of overruns. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ring</td><td>Emergency ring. </td></tr>
  </table>
  </dd>
</dl>

<p class="definition">Definition at line <a class="el" href="coe__emerg__ring_8c_source.html#l00170">170</a> of file <a class="el" href="coe__emerg__ring_8c_source.html">coe_emerg_ring.c</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="dir_c1346cf4828efdd0d2baf0d391d01b77.html">master</a></li><li class="navelem"><a class="el" href="coe__emerg__ring_8h.html">coe_emerg_ring.h</a></li>
    <li class="footer">Generated by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
  </ul>
</div>
</body>
</html>
